Skip to content

Experimental Italian locale for MDN, aimed at Italian-speaking users that prefer to read MDN Web Docs in their native language

License

Notifications You must be signed in to change notification settings

mdn/translated-content-it

Repository files navigation

Contributing to the Italian content of MDN Web Docs

πŸŽ‰ First of all, thank you for taking the time to contribute to MDN Web Docs! πŸŽ‰

The following is a set of guidelines for contributing to the Italian content of MDN Web Docs, which is hosted within the MDN Organization on GitHub.

Important

Please understand that the Italian content is fully machine-translated from the English content.

This means that manual updates will be overwritten by a newer machine-translation as soon as the corresponding English content changes.

The translation process is fully automated: For every changed page, we pre-process the English content, pass it along with this system prompt to an OpenAI model, and post-process the resulting Italian content before committing and pushing it to this repository.

Contributing

You can contribute to the Italian content in the following ways:

  1. Report issues you see.
  2. Review issues reported by other users.
  3. Contribute to the translation glossary.
  4. Review the the translation prompt.

1. Reporting issues

If you see any issues with the Italian content, please report them:

  • Create a GitHub issue using the "Report a problem with this content" links at the bottom of any Italian MDN page.
  • Mention the issue on Discord in the #italian channel.

Please prioritize reporting the following types of issues:

  • Systematic and recurring errors affecting multiple MDN pages.
  • Major errors that significantly hinder accuracy or comprehension.

2. Reviewing issues

If you see any open issues here, please review them:

  • Add emoji reactions to signal that you agree (πŸ‘), disagree (πŸ‘Ž), or that you're looking into it (πŸ‘€).
  • Add comments to provide additional context, examples, or solutions.
  • Bring up the issue on Discord in the #italian channel.

3. Contributing to the glossary

You can contribute to the Italian translation glossary:

  • Suggest a new glossary entry by commenting in the file.
  • Review the translations in the glossary, and provide feedback.
  • Create a new "Glossary" issue.

Note

The translation glossary is a work in progress.

It will be used to improve translations by passing matching glossary entries along with the system prompt.

4. Reviewing the prompt

If you have experience with prompt engineering, please review the system prompt, and provide feedback:

Code of Conduct

Everyone participating in this project is expected to follow our Code of Conduct.

License

When contributing to the content you agree to license your contributions according to our license.

Contribute to MDN Web Docs

You can contribute to MDN Web Docs and be a part of our community through content contributions, engineering, or translation work. The MDN Web Docs project welcomes contributions from everyone who shares our goals and wants to contribute constructively and respectfully within our community.

By participating in and contributing to our projects and discussions, you acknowledge that you have read and agree to our Code of Conduct.

Get in touch

You can communicate with the MDN Web Docs team and community using the communication channels.

Additionally, you can communicate with a specific localization team using their own available communication channels.

About

Experimental Italian locale for MDN, aimed at Italian-speaking users that prefer to read MDN Web Docs in their native language

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published